Bytecode level coverage reporting #6563
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
The coverage testing in foundry is useful, but has many outstanding issues, eg those mentioned here:
#1961
The barrier to entry in addressing these issues is relatively high, as the pipeline used to generate the reports is somewhat complex:
and there is no useful visibility into the interior stages of this pipeline.
Solution
This PR adds a new coverage report, that provided human readable bytecode level (ie per instruction) output.
This generates a directory of disassembled bytecode files that include hit counts for each instruction, along with a precise source reference. This output corresponds to the results from stage 2 in the pipeline description above.
An example snippet from a bytecode coverage file: